/*----------------------------------------------------------------------------------------
*
*  Copyright 2019, Gao Hai Hui, <fromzeropoint@126.com>.  All rights reserved.
*  https://gitee.com/helloworldghh/xoskit.git
*  Use of this source code is governed by a MIT license
*  that can be found in the License file.
*
----------------------------------------------------------------------------------------*/
#ifndef __375AB2A3_E5AF_45B0_9FA5_A211BF8CDECE__
#define __375AB2A3_E5AF_45B0_9FA5_A211BF8CDECE__

namespace xos_container
{
    class i_container;
}

namespace xos_package
{
    
    ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // 

    class i_package : public xos::i_release
    {
    protected:
        virtual ~i_package(){}

    public:
        // 
        // head md5(2) + body len(2) + body md5(2) + body(n)
        // 
        // 返回值定义：
        //  0  : 成功解到一包数据
        //	1  : 数据不够一包
        // -1  : 是非法的数据包，应该断掉连接
        // -2  : 解包出错，数据包不正确，应该断掉连接
        // 
        virtual int un_pack( xos_box::i_list * pOutputList, xos_box::i_list * pInputList ) = 0;
        // 
        // head md5(2) + body len(2) + body md5(2) + body(n)
        // 
        // 返回值定义
        // 
        // 0  : 成功
        // -1 : 失败，有包数据太长( len <= xos_box::i_buf::BUF_SIZE - 6 )
        // 
        virtual int pack( xos_box::i_list * pOutputList, xos_box::i_list * pInputList ) = 0;

        // 
        // 干扰key,用来混入md5计算，让试图破解的人无从判断包头的计算规则
        // 
        virtual int set_md5_key( const char * lpszKey ) = 0;
    };

    ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // 

    class i_all : public xos::i_release
    {
    protected:
        virtual ~i_all(){}

    public:
        // 
        // head md5(2) + body len(2) + body md5(2) + body(n)
        // 
        // 返回值定义：
        //  0  : 成功解到一包数据
        //	1  : 数据不够一包
        // -1  : 是非法的数据包，应该断掉连接
        // -2  : 解包出错，数据包不正确，应该断掉连接
        //
        virtual int un_pack( xos_box::i_list * pOutputList, xos_box::i_list * pInputList ) = 0;
        // 
        // head md5(2) + body len(2) + body md5(2) + body(n)
        // 
        // 返回值定义
        // 
        // 0  : 成功
        // -1 : 失败，有包数据太长( len <= xos_box::i_buf::BUF_SIZE - 6 )
        // 
        virtual int pack( xos_box::i_list * pOutputList, xos_box::i_list * pInputList, xos_compress::enumObjType eType ) = 0;

        // 
        // 3Des密码
        // 
        virtual int set_3des_key( const char * lpszKey, int nKeyLen ) = 0;

        // 
        // 干扰key,用来混入md5计算，让试图破解的人无从判断包头的计算规则
        // 
        virtual int set_md5_key( const char * lpszKey ) = 0;
    };

    ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // 
    // package模块主接口
    // 
    class i_package_mgr : public xos::i_release
    {
    protected:
        virtual ~i_package_mgr(){}

    public:
        virtual i_package* package() = 0;
        virtual i_all* all() = 0;
    };

    ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    // 
    // 导出函数定义
    // 
    typedef int ( * f_create )( xos_container::i_container * pContainer, i_package_mgr ** ppv );

} // xos_package

#endif // __375AB2A3_E5AF_45B0_9FA5_A211BF8CDECE__
